Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Just and Justfile modules for better dev experience #1537

Merged
merged 2 commits into from
May 24, 2024
Merged

Update Just and Justfile modules for better dev experience #1537

merged 2 commits into from
May 24, 2024

Conversation

spwoodcock
Copy link
Member

What type of PR is this? (check all applicable)

  • 🍕 Feature
  • 🐛 Bug Fix
  • 📝 Documentation
  • 🧑‍💻 Refactor
  • ✅ Test
  • 🤖 Build or CI
  • ❓ Other (please specify)

Describe this PR

  • This PR should significantly improve developer experience by wrapping useful commands in a Justfile.
  • We can now run just xxx to do things.
  • For example, to start up a local instance of FMTM for development, with all Cloudflared tunnels configured for mobile access, run just start tunnel.
    • All 4 services are tunneled with unique URLs: frontend, API, ODK Central, S3
    • XForms can be debugged using localhost easily with this config.

Screenshots

We get a URL like this to access:

image

Alternative Approaches Considered

Makefile, but there are many reasons why Justfiles are better.

Review Guide

Install Just, then run commands.

Checklist before requesting a review

[optional] What gif best describes this PR or how it makes you feel?

@spwoodcock spwoodcock added the devops Related to deployment or configuration label May 24, 2024
@spwoodcock spwoodcock self-assigned this May 24, 2024
@github-actions github-actions bot added docs Improvements or additions to documentation contrib labels May 24, 2024
@spwoodcock
Copy link
Member Author

spwoodcock commented May 24, 2024 •
edited
Loading

For the dev team @nrjadkry @Sujanadh @varun2948 @NSUWAL123
If you need to debug either the frontend or ODK Central forms via your mobile, then run:
just start tunnel

This will start all services and configure all required environment variables.
You get an output like this:
image

Then simply access the frontend URL, create a project using the ODK Central URL, and then debug the entire flow of using FMTM/ODK Collect (including loading by intent etc).

I can run through this in the next meeting if needed 👍

@spwoodcock spwoodcock changed the title Build/just commands Update Just and Justfile modules for better dev experience May 24, 2024
@spwoodcock spwoodcock merged commit 5bf93cb into development May 24, 2024
2 checks passed
@spwoodcock spwoodcock deleted the build/just-commands branch May 24, 2024 17:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Sujanadh Sujanadh Sujanadh approved these changes

@NSUWAL123 NSUWAL123 NSUWAL123 approved these changes

@nrjadkry nrjadkry Awaiting requested review from nrjadkry

Assignees

@spwoodcock spwoodcock

Labels
devops Related to deployment or configuration docs Improvements or additions to documentation
Projects
Field Mapping Tasking Manager (FMTM)
Status: Done
Milestone
(2024.3.1) Release (June)
Development

Successfully merging this pull request may close these issues.
3 participants
@spwoodcock @NSUWAL123 @Sujanadh